Inscoper::SubDeviceId

SubDeviceId class uniquely identifies a sub-device. More...

#include <SubDeviceId.h>

Public Functions

	Name
	SubDeviceId() Default constructor.
	SubDeviceId(const std::string & deviceId, const std::string & subDeviceId) Constructor.
	~SubDeviceId() Default destructor.
const std::string &	getDeviceId() const Get the device ID.
void	setDeviceId(const std::string & deviceId) Set the device ID.
const std::string &	getSubDeviceId() const Get the sub-device ID.
void	setSubDeviceId(const std::string & subDeviceId) Set the sub-device ID.
const std::string &	getName() const Get the full unique name.
bool	equals(const SubDeviceId & other) const Check equality.

Detailed Description

class Inscoper::SubDeviceId;

SubDeviceId class uniquely identifies a sub-device.

This class encapsulates the identity of a sub-device, consisting of a parent device identifier and a specific sub-device identifier.

Public Functions Documentation

function SubDeviceId

SubDeviceId()

Default constructor.

Initializes a new instance of the SubDeviceId class.

function SubDeviceId

SubDeviceId(
    const std::string & deviceId,
    const std::string & subDeviceId
)

Constructor.

Parameters:

• deviceId : The device ID
• subDeviceId : The sub-device ID

Initializes a new instance of the SubDeviceId class with specified device and sub-device IDs.

function ~SubDeviceId

~SubDeviceId()

Default destructor.

function getDeviceId

const std::string & getDeviceId() const

Get the device ID.

Return: The device ID

Retrieves the identifier of the parent device.

function setDeviceId

void setDeviceId(
    const std::string & deviceId
)

Set the device ID.

Parameters:

• deviceId : The device ID

Sets the identifier of the parent device.

function getSubDeviceId

const std::string & getSubDeviceId() const

Get the sub-device ID.

Return: The sub-device ID

Retrieves the identifier of the sub-device.

function setSubDeviceId

void setSubDeviceId(
    const std::string & subDeviceId
)

Set the sub-device ID.

Parameters:

• subDeviceId : The sub-device ID

Sets the identifier of the sub-device.

function getName

const std::string & getName() const

Get the full unique name.

Return: The full unique name

Retrieves a concatenation of the device ID and sub-device ID in the format 'deviceId-subDeviceId'.

function equals

bool equals(
    const SubDeviceId & other
) const

Check equality.

Parameters:

• other : The other SubDeviceId to compare

Return: True if both IDs match, false otherwise

Compares this SubDeviceId with another for equality.

---

Updated on 2026-04-02 at 10:55:36 +0200